Xceed .NET Libraries Documentation
Xceed.Tar Assembly / Xceed.Tar Namespace / QuickTar Class / Remove Method / Remove(String,Boolean,Boolean,String[]) Method
The full path of the Tar archive.
Boolean value indicating whether files contained within sub-folders should be removed from the Tar file.
Boolean value indicating if the tar file was compressed using GZip. Note: The GZip file retrieved must have the following format: tarFileName.gz. An exception is thrown if the Tar archive is not compressed.
The files to remove from tarFileName. Cannot be a null reference (Nothing in Visual Basic).


    Remove(String,Boolean,Boolean,String[]) Method
    Removes files from a Tar archive, specifying whether files contained within sub-folders will also be removed.
    Syntax
    'Declaration
     
    Public Overloads Shared Sub Remove( _
       ByVal tarFileName As String, _
       ByVal recursive As Boolean, _
       ByVal isTarCompressed As Boolean, _
       ByVal ParamArray filesToRemove() As String _
    ) 
     
    'Usage
     
    Dim tarFileName As String
    Dim recursive As Boolean
    Dim isTarCompressed As Boolean
    Dim filesToRemove() As String
     
    QuickTar.Remove(tarFileName, recursive, isTarCompressed, filesToRemove)

    Parameters

    tarFileName
    The full path of the Tar archive.
    recursive
    Boolean value indicating whether files contained within sub-folders should be removed from the Tar file.
    isTarCompressed
    Boolean value indicating if the tar file was compressed using GZip. Note: The GZip file retrieved must have the following format: tarFileName.gz. An exception is thrown if the Tar archive is not compressed.
    filesToRemove
    The files to remove from tarFileName. Cannot be a null reference (Nothing in Visual Basic).
    Remarks

    Tar files are case sensitive; therefore, the string passed in the filesToRemove parameter will be used "as-is".

    For example, if a Tar archive contains a file named "FILE.TXT" and "file.txt" is passed to the filesToRemove parameter, "FILE.TXT" will not be removed.

    This implementation of Tar is fully read/write compatible with the USTAR format. It is read compatible with GNU Tar archives whose entries do not use the header extensions of this format.

    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also